home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / complib / claqhb.z / claqhb
Text File  |  1998-10-30  |  3KB  |  133 lines

  1.  
  2.  
  3.  
  4. CCCCLLLLAAAAQQQQHHHHBBBB((((3333FFFF))))                                                          CCCCLLLLAAAAQQQQHHHHBBBB((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CLAQHB - equilibrate a symmetric band matrix A using the scaling factors
  10.      in the vector S
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CLAQHB( UPLO, N, KD, AB, LDAB, S, SCOND, AMAX, EQUED )
  14.  
  15.          CHARACTER      EQUED, UPLO
  16.  
  17.          INTEGER        KD, LDAB, N
  18.  
  19.          REAL           AMAX, SCOND
  20.  
  21.          REAL           S( * )
  22.  
  23.          COMPLEX        AB( LDAB, * )
  24.  
  25. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  26.      CLAQHB equilibrates a symmetric band matrix A using the scaling factors
  27.      in the vector S.
  28.  
  29.  
  30. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  31.      UPLO    (input) CHARACTER*1
  32.              Specifies whether the upper or lower triangular part of the
  33.              symmetric matrix A is stored.  = 'U':  Upper triangular
  34.              = 'L':  Lower triangular
  35.  
  36.      N       (input) INTEGER
  37.              The order of the matrix A.  N >= 0.
  38.  
  39.      KD      (input) INTEGER
  40.              The number of super-diagonals of the matrix A if UPLO = 'U', or
  41.              the number of sub-diagonals if UPLO = 'L'.  KD >= 0.
  42.  
  43.      AB      (input/output) COMPLEX array, dimension (LDAB,N)
  44.              On entry, the upper or lower triangle of the symmetric band
  45.              matrix A, stored in the first KD+1 rows of the array.  The j-th
  46.              column of A is stored in the j-th column of the array AB as
  47.              follows:  if UPLO = 'U', AB(kd+1+i-j,j) = A(i,j) for max(1,j-
  48.              kd)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  49.              j<=i<=min(n,j+kd).
  50.  
  51.              On exit, if INFO = 0, the triangular factor U or L from the
  52.              Cholesky factorization A = U'*U or A = L*L' of the band matrix A,
  53.              in the same storage format as A.
  54.  
  55.      LDAB    (input) INTEGER
  56.              The leading dimension of the array AB.  LDAB >= KD+1.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCLLLLAAAAQQQQHHHHBBBB((((3333FFFF))))                                                          CCCCLLLLAAAAQQQQHHHHBBBB((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      S       (output) REAL array, dimension (N)
  75.              The scale factors for A.
  76.  
  77.      SCOND   (input) REAL
  78.              Ratio of the smallest S(i) to the largest S(i).
  79.  
  80.      AMAX    (input) REAL
  81.              Absolute value of largest matrix entry.
  82.  
  83.      EQUED   (output) CHARACTER*1
  84.              Specifies whether or not equilibration was done.  = 'N':  No
  85.              equilibration.
  86.              = 'Y':  Equilibration was done, i.e., A has been replaced by
  87.              diag(S) * A * diag(S).
  88.  
  89. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  90.      THRESH is a threshold value used to decide if scaling should be done
  91.      based on the ratio of the scaling factors.  If SCOND < THRESH, scaling is
  92.      done.
  93.  
  94.      LARGE and SMALL are threshold values used to decide if scaling should be
  95.      done based on the absolute size of the largest matrix element.  If AMAX >
  96.      LARGE or AMAX < SMALL, scaling is done.
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.